home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Source Code / Visual Basic Source Code.iso / vbsource / vbdatabs / persist.cpp < prev    next >
C/C++ Source or Header  |  1999-03-14  |  8KB  |  277 lines
  1. // ------------------------------- //
  2. // -------- Start of File -------- //
  3. // ------------------------------- //
  4. // ----------------------------------------------------------- // 
  5. // C++ Source Code File Name: persist.cpp 
  6. // Compiler Used: MSVC40, DJGPP 2.7.2.1, GCC 2.7.2.1, HP CPP 10.24
  7. // Produced By: Doug Gaer  
  8. // File Creation Date: 09/18/1997  
  9. // Date Last Modified: 03/15/1999
  10. // Copyright (c) 1997 Douglas M. Gaer
  11. // ----------------------------------------------------------- // 
  12. // ------------- Program Description and Details ------------- // 
  13. // ----------------------------------------------------------- // 
  14. /*
  15. The VBD C++ classes are copyright (c) 1997, by Douglas M. Gaer.
  16. All those who put this code or its derivatives in a commercial
  17. product MUST mention this copyright in their documentation for
  18. users of the products in which this code or its derivative
  19. classes are used. Otherwise, you have the freedom to redistribute
  20. verbatim copies of this source code, adapt it to your specific
  21. needs, or improve the code and release your improvements to the
  22. public provided that the modified files carry prominent notices
  23. stating that you changed the files and the date of any change.
  24.  
  25. THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
  26. THE ENTIRE RISK OF THE QUALITY AND PERFORMANCE OF THIS SOFTWARE
  27. IS WITH YOU. SHOULD ANY ELEMENT OF THIS SOFTWARE PROVE DEFECTIVE,
  28. YOU WILL ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR
  29. CORRECTION.
  30.   
  31. The (P)ersistent base class is used to define the interface 
  32. that makes the object persistent. 
  33. */
  34. // ----------------------------------------------------------- // 
  35. #include "persist.h"
  36.  
  37. void Persistent::Connect(POD *DB) 
  38. {
  39.   if(!DB->OpenDatabase())
  40. #ifdef CPP_EXCEPTIONS
  41.     throw CNoDatabaseOpen();
  42. #else
  43.     Error->SignalException(EHandler::NoDatabaseOpen);
  44. #endif
  45.     pod = DB;
  46. }
  47.  
  48. void Persistent::Connect(const POD *DB) 
  49. {
  50.   if(!DB->OpenDatabase())
  51. #ifdef CPP_EXCEPTIONS
  52.     throw CNoDatabaseOpen();
  53. #else
  54.     Error->SignalException(EHandler::NoDatabaseOpen);
  55. #endif
  56.     pod = (POD *)DB;
  57. }
  58.  
  59. void Persistent::WriteObjHeader(const ObjectHeader &oh, FAU addr)
  60. {
  61.   pod->OpenDatabase()->Write(&oh, sizeof(ObjectHeader), addr);
  62. }
  63.  
  64. void Persistent::ReadObjHeader(ObjectHeader &oh, FAU addr)
  65. {
  66.   pod->OpenDatabase()->Read(&oh, sizeof(ObjectHeader), addr);
  67. }
  68.  
  69. __UWORD__ Persistent::StringFileLength(const UString &s)
  70. // Calculates the total number of bytes to be allocated for
  71. // the string in the file.
  72. {
  73.   __UWORD__ len = s.length();
  74.   return len + sizeof(UINT32); 
  75. }
  76.  
  77. __UWORD__ Persistent::StringFileLength(const char *s)
  78. // Calculates the total number of bytes to be allocated for
  79. // the string in the file.
  80. {
  81.   __UWORD__ len;
  82.   // Ensure at least one byte is alloacted
  83.   if(s) len = strlen(s); else len = 1; 
  84.   return len + sizeof(UINT32); 
  85. }
  86.  
  87. __UWORD__ Persistent::StringFileLength(char *s)
  88. // Calculates the total number of bytes to be allocated for
  89. // the string in the file.
  90. {
  91.   __UWORD__ len;
  92.   // Ensure at least one byte is alloacted
  93.   if(s) len = strlen(s); else len = 1;
  94.   return len + sizeof(UINT32); 
  95. }
  96.  
  97. void Persistent::WriteString(const UString &s, FAU addr)
  98. {
  99.   UINT32 len = s.length(); // Record the logical length of the string
  100.   pod->OpenDatabase()->Write(&len, sizeof(UINT32), addr);
  101.   if(addr == CurrAddress)
  102.     pod->OpenDatabase()->Write(s.c_str(), len);
  103.   else
  104.     pod->OpenDatabase()->Write(s.c_str(), len, addr+sizeof(UINT32));  
  105. }
  106.  
  107. void Persistent::WriteString(const char *s, FAU addr)
  108. {
  109.   UINT32 len;
  110.   const char *null_byte = 0; 
  111.   
  112.   // Record the logical length of the string and ensure at least one
  113.   // byte is written if the char *s == 0
  114.   if(s)
  115.     len = strlen(s);
  116.   else
  117.     len = 1;
  118.  
  119.   pod->OpenDatabase()->Write(&len, sizeof(UINT32), addr);
  120.  
  121.   if(s) {
  122.     if(addr == CurrAddress)
  123.       pod->OpenDatabase()->Write(s, len);
  124.     else
  125.       pod->OpenDatabase()->Write(s, len, addr+sizeof(UINT32));
  126.   }
  127.   else {
  128.     if(addr == CurrAddress)
  129.       pod->OpenDatabase()->Write(&null_byte, len);
  130.     else
  131.       pod->OpenDatabase()->Write(&null_byte, len, addr+sizeof(UINT32));
  132.   }
  133. }
  134.  
  135. void Persistent::WriteString(char *s, FAU addr)
  136. {
  137.   UINT32 len;
  138.   const char *null_byte = 0; 
  139.   
  140.   // Record the logical length of the string and ensure at least one
  141.   // byte is written if the char *s == 0
  142.   if(s)
  143.     len = strlen(s);
  144.   else
  145.     len = 1;
  146.  
  147.   pod->OpenDatabase()->Write(&len, sizeof(UINT32), addr);
  148.  
  149.   if(s) {
  150.     if(addr == CurrAddress)
  151.       pod->OpenDatabase()->Write(s, len);
  152.     else
  153.       pod->OpenDatabase()->Write(s, len, addr+sizeof(UINT32));
  154.   }
  155.   else {
  156.     if(addr == CurrAddress)
  157.       pod->OpenDatabase()->Write(&null_byte, len);
  158.     else
  159.       pod->OpenDatabase()->Write(&null_byte, len, addr+sizeof(UINT32));
  160.   }
  161. }
  162.  
  163. void Persistent::ReadString(UString &s, FAU addr)
  164. {
  165.   UINT32 len ;
  166.   pod->OpenDatabase()->Read(&len, sizeof(UINT32), addr);
  167.   char *buf = new char[len + 1];
  168.   if(addr == CurrAddress)
  169.     pod->OpenDatabase()->Read(buf, len);
  170.   else
  171.     pod->OpenDatabase()->Read(buf, len, addr+sizeof(UINT32));
  172.  
  173.   buf[len] = '\0'; // String must be null terminated
  174.   s = buf;
  175.   delete buf;
  176. }
  177.  
  178. char *Persistent::ReadString(FAU addr)
  179. {
  180.   UINT32 len ;
  181.   pod->OpenDatabase()->Read(&len, sizeof(UINT32), addr);
  182.   char *buf = new char[len + 1];
  183.  
  184.   if(addr == CurrAddress)
  185.     pod->OpenDatabase()->Read(buf, len);
  186.   else
  187.     pod->OpenDatabase()->Read(buf, len, addr+sizeof(UINT32));
  188.  
  189.   buf[len] = '\0'; // String must be null terminated
  190.   return buf;
  191. }
  192.  
  193. FAU Persistent::AddObject(int find)
  194. // Will search the entire index file or database for the object
  195. // if find is true.
  196. {
  197.   FAU addr;
  198.   if(find) {
  199.     addr = Find();
  200.     if(!addr) addr = Write();
  201.     return addr;
  202.   }
  203.   addr = Write();
  204.   return addr;
  205. }
  206.  
  207. void Persistent::DeleteObject(FAU addr)
  208. // Delete the object at the specifed address
  209. {
  210.   pod->OpenDatabase()->Delete(addr);
  211. }
  212.  
  213. void Persistent::RemoveObject(FAU addr)
  214. // Remove the object at the specifed address
  215. {
  216.   pod->OpenDatabase()->Remove(addr);
  217. }
  218.  
  219. FAU Persistent::ObjectAddress(int find)
  220. // Will search the entire database for the object if find is true
  221. {
  222.   FAU addr;
  223.  
  224.   if(find) {
  225.     addr = Find();
  226.     if(!addr) return 0; // Object does not exist
  227.     SetObjectAddress(addr);
  228.     return addr;
  229.   }
  230.  
  231.   return objectaddress;
  232. }
  233.  
  234. int Persistent::CompareIndex()
  235. // Used by derived class to compare the Index file
  236. // to the Data file. Returns true if the Index file
  237. // keys match the Data file objects.
  238. {
  239.   // The application specific code must be defined by
  240.   // the derived class.
  241.  
  242.   // Nothing to do in base class. Always return false.
  243.   return 0;
  244. }
  245.  
  246. int Persistent::RebuildIndexFile(const char *fname)
  247. // Used by derived class to rebuild the Index file.
  248. // Returns true if the Index file was rebuild with
  249. // no errors
  250. {
  251.   // The application specific code must be defined by
  252.   // the derived class.
  253.  
  254.   // Nothing to do in base class. Always return false.
  255.   return 0;
  256. }
  257.  
  258. int Persistent::AddKey(EntryKey &key, int flush)
  259. {
  260.   return pod->Index()->Add(key, flush);
  261. }
  262.  
  263. int Persistent::FindKey(EntryKey &key, int full_search)
  264. {
  265.   if(full_search) return pod->Index()->FullSearch(key);
  266.   return pod->Index()->Search(key);
  267. }
  268.  
  269. int Persistent::RemoveKey(EntryKey &key, int flush)
  270. {
  271.   return pod->Index()->Remove(key, flush);
  272. }
  273. // ----------------------------------------------------------- //
  274. // ------------------------------- //
  275. // --------- End of File --------- //
  276. // ------------------------------- //
  277.